MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test by sandboxcoder · Pull Request #1691 · streamlabs/obs-studio-node

sandboxcoder · 2026-05-06T22:16:56Z

Description

Restore commit 9279b8a now that this has been fully root caused. Bringing back this change because it fixes the case where coreaudio spins up a reconnect_thread whenever Desktop queries for audio devices. This was because the previous implementation passed in a dummy device which causes coreaudio to create a thread to poll if this dummy device is later initialized. This will cleanup the logs eliminating this warning (32 occurrences in a log I checked from Desktop): [Warning] [coreaudio_get_device_name] failed to get name: 560947818
Set CI env flag for mac test CI. This is so we can use the new obs.isCI() function to determine if we're running in a CI env (no GPU) very quickly from the tests.
Adds a test for OBS_settings_getVideoDevices.
test_osn_advanced_replayBuffer.ts: still flaky on macOS test runner so
disable on CI runner
Set CMAKE_OSX_DEPLOYMENT_TARGET to MacOS 12. now matches SLOBS which is set here

Performance:
New implementation (nanoseconds)

[000:00:00:03.691.221.250][66014221][Info] OBS_settings_getInputAudioDevices took 400125
[000:00:00:03.691.641.333][66014221][Info] OBS_settings_getOutputAudioDevices took 288458

Old (nanoseconds)

[000:00:00:03.530.971.333][65989647][Info] OBS_settings_getInputAudioDevices took 721292
[000:00:00:03.531.601.833][65989647][Info] OBS_settings_getOutputAudioDevices took 479084

The new enumDevices implementation is more efficient since it does not create a dummy_source. Also, it avoids triggering coreaudio to create a reconnect_thread for a dummy device (which saves us another 2ms or so in an async thread because mac-coreaudio polls within the reconnect_thread).

Motivation and Context

When I was looking into profiling missing source devices it reminded me that getDevices() triggers coreaudio to create a reconnect_thread which does later get reaped however it did not seem ideal. But it would be nice to avoid this. Currently, desktop queries getAudioDevices() at least around 14 times so it is nice to optimize this to get the app to load up faster and spin up less threads.

How Has This Been Tested?

Locally, I verified the same audio/video devices are output. Originally, commit 9279b8a was reverted due to breaking the old onboarding flow (no webcam detected) but that is addressed in this PR since we will enumerate video devices using the legacy approach.

Types of changes

Performance enhancement (non-breaking change which improves efficiency)

Checklist:

The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

Copilot

Pull request overview

This PR reintroduces and refines a getDevices optimization to avoid creating dummy sources (notably preventing CoreAudio from spinning up unnecessary reconnect threads), adds a macOS-specific video device enumeration path to avoid plugin initialization requirements, and updates CI/test utilities to better handle Darwin CI constraints.

Changes:

Replace dummy-source-based property enumeration with obs_get_source_properties() for device listing, and add warning logs on property lookup failures.
Implement manual macOS video device enumeration via AVFoundation and route OBS_settings_getVideoDevices (macOS) through it.
Add/adjust OSN tests and CI flags to better detect Darwin CI and validate video device enumeration output shape.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/osn-tests/util/obs_handler.ts	Adds `isOnDarwinCI()` helper for test gating on macOS CI.
tests/osn-tests/util/error_messages.ts	Adds new error messages for video device enumeration tests.
tests/osn-tests/src/test_osn_video.ts	Adds a test for `OBS_settings_getVideoDevices()` return shape and (non-CI) non-empty expectation.
tests/osn-tests/src/test_osn_audio.ts	Gates default output device expectation behind `isOnDarwinCI()`.
obs-studio-server/source/nodeobs_settings.cpp	Updates `getDevices()` to avoid dummy source creation; macOS video devices now enumerated via new macOS helper.
obs-studio-server/source/nodeobs_settings-osx.mm	New AVFoundation-based macOS video device enumeration implementation.
obs-studio-server/source/nodeobs_settings-osx.h	Declares macOS video device enumeration helper.
obs-studio-server/CMakeLists.txt	Adds new macOS settings enumeration sources to the build.
.github/workflows/main.yml	Explicitly sets `CI=true` for the macOS test job environment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

CLAassistant · 2026-05-06T23:52:05Z

All committers have signed the CLA.

This reverts commit 4434fda.

Copilot

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 1 comment.

sandboxcoder · 2026-05-08T14:35:20Z

 # Comfigure macos architecture and min version
 iF(APPLE)
-	set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET[arch=arm64] "11.0")
-	set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET[arch=x86_64] "10.15")
+	set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET[arch=arm64] "12.0")
+	set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET[arch=x86_64] "12.0")
 	if (NOT CMAKE_OSX_ARCHITECTURES)


Yes, Streamlabs Desktop minimum version is actually MacOS 12 (this version in particular is special, my minspec Intel laptop is set to MacOS 12 while the Mac M4 is using latest). I just never updated the deployment target in the xcode cmake file because we never needed to bump it (only reason I was thinking to bump it now is to make it obvious there is no need for fallback code for anything older then macOS 12) but should have bumped this much earlier...

This matches SLOBS Deployment target now.

…es() * rename legacy getDevices() -> getDevicesUsingDummySource(). Adding more error checking * set CI flag for MacOS test runner so it can use obs.isCI()

sandboxcoder force-pushed the rno/get-properties branch from 3a0c9ba to a935b64 Compare May 6, 2026 23:14

sandboxcoder requested a review from Copilot May 6, 2026 23:32

Copilot started reviewing on behalf of sandboxcoder May 6, 2026 23:33 View session

Copilot AI reviewed May 6, 2026

View reviewed changes

Copilot started work on behalf of sandboxcoder May 6, 2026 23:51 View session

Copilot finished work on behalf of sandboxcoder May 6, 2026 23:52

Revert "settings: revert 01b09d9 / fix device list (#1609)"

81c832a

This reverts commit 4434fda.

sandboxcoder force-pushed the rno/get-properties branch 3 times, most recently from 32817d2 to 8b48df9 Compare May 7, 2026 15:36

sandboxcoder changed the title ~~getDevice optimization~~ MacOS getDevice() optimization, set CI env var, & add getVideoDevices() test May 7, 2026

sandboxcoder requested a review from Copilot May 7, 2026 17:18

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 17:19 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread tests/osn-tests/util/obs_handler.ts

Comment thread obs-studio-server/source/nodeobs_settings.cpp

sandboxcoder requested a review from Copilot May 7, 2026 18:12

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 18:12 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread tests/osn-tests/src/test_osn_advanced_replayBuffer.ts

Comment thread tests/osn-tests/src/test_osn_advanced_replayBuffer.ts

Comment thread tests/osn-tests/src/test_osn_audio.ts Outdated

Comment thread tests/osn-tests/src/test_osn_video.ts Outdated

sandboxcoder force-pushed the rno/get-properties branch from 65e6812 to 9b7e04f Compare May 7, 2026 18:20

sandboxcoder requested a review from Copilot May 7, 2026 18:24

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 18:25 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread tests/osn-tests/src/test_osn_audio.ts Outdated

Comment thread tests/osn-tests/src/test_osn_video.ts Outdated

aleksandr-voitenko reviewed May 7, 2026

View reviewed changes

Comment thread obs-studio-server/source/nodeobs_settings.cpp Outdated

sandboxcoder requested a review from Copilot May 7, 2026 20:29

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 20:29 View session

aleksandr-voitenko reviewed May 7, 2026

View reviewed changes

Comment thread obs-studio-server/source/nodeobs_settings-osx.mm Outdated

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread tests/osn-tests/src/test_osn_audio.ts Outdated

sandboxcoder requested a review from Copilot May 7, 2026 21:08

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 21:09 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread CMakeLists.txt

sandboxcoder requested a review from Copilot May 7, 2026 21:22

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 21:23 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread obs-studio-server/source/nodeobs_settings-osx.mm Outdated

Comment thread obs-studio-server/source/nodeobs_settings-osx.mm Outdated

sandboxcoder requested a review from Copilot May 7, 2026 22:03

Copilot started reviewing on behalf of sandboxcoder May 7, 2026 22:03 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

sandboxcoder requested a review from Copilot May 8, 2026 14:15

Copilot started reviewing on behalf of sandboxcoder May 8, 2026 14:15 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

sandboxcoder force-pushed the rno/get-properties branch from 72cd389 to d4537f7 Compare May 8, 2026 19:19

set target 12.0, add video test, replay-buffer test skip CI, getDevic…

d56cf32

…es() * rename legacy getDevices() -> getDevicesUsingDummySource(). Adding more error checking * set CI flag for MacOS test runner so it can use obs.isCI()

sandboxcoder force-pushed the rno/get-properties branch from 6623119 to d56cf32 Compare May 8, 2026 23:54

aleksandr-voitenko approved these changes May 11, 2026

View reviewed changes

Conversation

sandboxcoder commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CLAassistant commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

sandboxcoder May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sandboxcoder commented May 6, 2026 •

edited

Loading

CLAassistant commented May 6, 2026 •

edited

Loading

sandboxcoder May 8, 2026 •

edited

Loading